ODk Test Framework (версия 2.4.1)/io.bitbucket.dsmoons.framework.odk/PageBase

PageBase

open class PageBase<T : PageBase<T>> @JvmOverloads constructor(val baseHelper: BaseHelper, val link: String? = null) : PageHelper

Базовый класс, от которого наследуются классы страниц, реализующие шаблон Page Object.

Предоставляет методы для взаимодействия со страницей браузера и методы создания элементов (getElementById, getElementByXpath и другие).

Пример страницы:

public class Page extends PageBase<Page> {
    public Element element = getElementById("id", "Описание элемента");

    public Page(BaseHelper baseHelper) {
        super(baseHelper, PropertiesHelper.getProperty("page.link"));
    }

    public Page doSomething() {
        element.click();
        // ...
        // ...
        return this;
    }
}

Пример использования страницы:

pages.page.open();
pages.page.doSomething();
pages.page.refresh();

или (fluent-стиль)

pages.page.open()
        .doSomething()
        .refresh();

и т.д.

Parameters

baseHelper

Объект базового класса

link

По умолчанию null. Ссылка на страницу

Constructors

PageBase

@JvmOverloads

constructor(baseHelper: BaseHelper, link: String? = null)

Конструктор класса

Types

Alert

class Alert<T : PageBase<T>>(val browser: Browser, val pageBase: PageBase<T>)

Класс с методами взаимодействия с диалоговыми окнами на странице.

class Cookies<T : PageBase<T>>(val browser: Browser, val pageBase: PageBase<T>)

Класс с методами взаимодействия с Cookie.

Frame

class Frame<T : PageBase<T>>(val browser: Browser, val pageBase: PageBase<T>)

Класс с методами взаимодействия с фреймами на странице.

JSExecutor

class JSExecutor<T : PageBase<T>>(val browser: Browser, val pageBase: PageBase<T>)

Класс с методами выполнения скриптов JavaScript

Window

class Window<T : PageBase<T>>(val browser: Browser, val pageBase: PageBase<T>)

Класс с методами изменения размера окна браузера, действий с вкладками.

Properties

base

private val base: BaseHelper

baseHelper

private val baseHelper: BaseHelper

browser

private val browser: Browser

link

private val link: String? = null

Functions

getActiveElement

fun getActiveElement(): Element

Получение активного элемента - элемента, на котором установлен фокус. Если фокуса нет ни на одном элементе, то возвращается элемент body

getAlert

fun getAlert(): PageBase.Alert<T>

Возвращает объект с методами взаимодействия с диалогововыми окнами на странице

getCookies

fun getCookies(): PageBase.Cookies<T>

Возвращает объект с методами взаимодействия с Cookie

getDevTools

fun getDevTools(): DevTools

Получение объекта DevTools

getElementByClassName

@JvmOverloads

protected fun getElementByClassName(className: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью className в качестве локатора

@JvmOverloads

protected fun getElementByClassName(parent: Element, className: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью className в качестве локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск

getElementByCssSelector

@JvmOverloads

protected fun getElementByCssSelector(cssSelector: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью cssSelector в качестве локатора.

@JvmOverloads

protected fun getElementByCssSelector(parent: Element, cssSelector: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью cssSelector в качестве локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск.

getElementByCustomLocator

@JvmOverloads

protected fun getElementByCustomLocator(locator: By, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью кастомного локатора.

@JvmOverloads

protected fun getElementByCustomLocator(parent: Element, locator: By, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью кастомного локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск.

getElementById

@JvmOverloads

protected fun getElementById(id: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью id в качестве локатора

@JvmOverloads

protected fun getElementById(parent: Element, id: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью id в качестве локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск

getElementByLinkText

@JvmOverloads

protected fun getElementByLinkText(linkText: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью linkText в качестве локатора

@JvmOverloads

protected fun getElementByLinkText(parent: Element, linkText: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью linkText в качестве локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск

getElementByName

@JvmOverloads

protected fun getElementByName(name: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью name в качестве локатора

@JvmOverloads

protected fun getElementByName(parent: Element, name: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью name в качестве локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск

getElementByPartialLinkText

@JvmOverloads

protected fun getElementByPartialLinkText(partialLinkText: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью partialLinkText в качестве локатора

@JvmOverloads

protected fun getElementByPartialLinkText(parent: Element, partialLinkText: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью partialLinkText в качестве локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск

getElementByRelativeLocator

@JvmOverloads

protected fun getElementByRelativeLocator(locator: RelativeLocator.RelativeBy, description: String, hidden: Boolean = false): Element

@JvmOverloads

protected fun getElementByRelativeLocator(parent: Element, locator: RelativeLocator.RelativeBy, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью относительного (org.openqa.selenium.support.locators.RelativeLocator.RelativeBy) локатора (создается методом org.openqa.selenium.support.locators.RelativeLocator.with). Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск.

getElementByTagName

@JvmOverloads

protected fun getElementByTagName(tagName: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью tagName в качестве локатора

@JvmOverloads

protected fun getElementByTagName(parent: Element, tagName: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью tagName в качестве локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск

getElementByXpath

@JvmOverloads

protected fun getElementByXpath(xpath: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью xpath в качестве локатора

@JvmOverloads

protected fun getElementByXpath(parent: Element, xpath: String, description: String, hidden: Boolean = false): Element

Создание объекта Element с помощью xpath в качестве локатора. Первым параметром метод принимает родительский Element, в контексте которого будет осуществляться поиск

getFrame

fun getFrame(): PageBase.Frame<T>

Возвращает объект с методами взаимодействия с фреймами на странице

getJavaScriptExecutor

fun getJavaScriptExecutor(): PageBase.JSExecutor<T>

Возвращает объект с методами выполнения javascript

getPage

protected fun <T : PageBase<T>> getPage(cls: Class<T>): T

Метод создает объект класса, описывающего страницу или часть страницы для паттерна PageObject. Класс должен наследоваться от PageBase

getWindow

fun getWindow(): PageBase.Window<T>

Возвращает объект с методами изменения размера окна браузера, действий с вкладками

navigate

fun navigate(url: URL?): PageBase<T>

fun navigate(link: String?): PageBase<T>

Переход по ссылке

navigateBack

fun navigateBack(): PageBase<T>

Переход на предыдущую страницу

navigateForward

fun navigateForward(): PageBase<T>

Переход на следующую страницу из истории браузера

open

fun open(): T

Переход на страницу. Если в конструктор класса PageBase, от которого наследуется класс страницы, не передан параметр link, то при вызове метода ничего не происходит

performActions

fun performActions(message: String, consumer: Consumer<Actions>): T

Выполнение действий над элементами с помощью Actions. Используется в связке с методом Element.toWebElement.

refresh

fun refresh(): T

Обновление страницы

setWebDriverSettings

fun setWebDriverSettings(message: String, consumer: Consumer<WebDriver>)

Настройка WebDriver через лямбду-consumer

sleep

fun sleep(millis: Long): T

Пауза в заданное количество миллисекунд.